<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpbrushselect: GIMP 3 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP 3 Library Reference Manual">
<link rel="up" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="prev" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">
<link rel="next" href="libgimp3-gimpfontselect.html" title="gimpfontselect">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libgimp3-gimpbrushselect.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimp-selectors.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GimpPatternSelectButton.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimp3-gimpfontselect.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp3-gimpbrushselect"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp3-gimpbrushselect.top_of_page"></a>gimpbrushselect</span></h2>
<p>gimpbrushselect — Functions providing a brush selection dialog.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp3-gimpbrushselect.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="libgimp3-gimpbrushselect.html#GimpRunBrushCallback" title="GimpRunBrushCallback ()">*GimpRunBrushCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrushselect.html#gimp-brush-select-new" title="gimp_brush_select_new ()">gimp_brush_select_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrushselect.html#gimp-brush-select-destroy" title="gimp_brush_select_destroy ()">gimp_brush_select_destroy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrushselect.html#gimp-brushes-popup" title="gimp_brushes_popup ()">gimp_brushes_popup</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrushselect.html#gimp-brushes-close-popup" title="gimp_brushes_close_popup ()">gimp_brushes_close_popup</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrushselect.html#gimp-brushes-set-popup" title="gimp_brushes_set_popup ()">gimp_brushes_set_popup</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp3-gimpbrushselect.description"></a><h2>Description</h2>
<p>Functions providing a brush selection dialog.</p>
</div>
<div class="refsect1">
<a name="libgimp3-gimpbrushselect.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GimpRunBrushCallback"></a><h3>GimpRunBrushCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GimpRunBrushCallback<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">gchar</span> *brush_name</code></em>,
                         <em class="parameter"><code><span class="type">gdouble</span> opacity</code></em>,
                         <em class="parameter"><code><span class="type">gint</span> spacing</code></em>,
                         <em class="parameter"><code><a class="link" href="libgimp3-gimpenums.html#GimpLayerMode" title="enum GimpLayerMode"><span class="type">GimpLayerMode</span></a> paint_mode</code></em>,
                         <em class="parameter"><code><span class="type">gint</span> width</code></em>,
                         <em class="parameter"><code><span class="type">gint</span> height</code></em>,
                         <em class="parameter"><code>const <span class="type">guchar</span> *mask_data</code></em>,
                         <em class="parameter"><code><span class="type">gboolean</span> dialog_closing</code></em>,
                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<div class="refsect3">
<a name="GimpRunBrushCallback.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>brush_name</p></td>
<td class="parameter_description"><p>Name of the brush</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>opacity</p></td>
<td class="parameter_description"><p>Opacity</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>spacing</p></td>
<td class="parameter_description"><p>Spacing</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>paint_mode</p></td>
<td class="parameter_description"><p>Paint mode</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>width</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>height</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mask_data</p></td>
<td class="parameter_description"><p>Mask data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>dialog_closing</p></td>
<td class="parameter_description"><p>Dialog closing?</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-select-new"></a><h3>gimp_brush_select_new ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gimp_brush_select_new (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
                       <em class="parameter"><code>const <span class="type">gchar</span> *brush_name</code></em>,
                       <em class="parameter"><code><span class="type">gdouble</span> opacity</code></em>,
                       <em class="parameter"><code><span class="type">gint</span> spacing</code></em>,
                       <em class="parameter"><code><a class="link" href="libgimp3-gimpenums.html#GimpLayerMode" title="enum GimpLayerMode"><span class="type">GimpLayerMode</span></a> paint_mode</code></em>,
                       <em class="parameter"><code><a class="link" href="libgimp3-gimpbrushselect.html#GimpRunBrushCallback" title="GimpRunBrushCallback ()"><span class="type">GimpRunBrushCallback</span></a> callback</code></em>,
                       <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
                       <em class="parameter"><code><span class="type">GDestroyNotify</span> data_destroy</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-select-destroy"></a><h3>gimp_brush_select_destroy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_brush_select_destroy (<em class="parameter"><code>const <span class="type">gchar</span> *brush_callback</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brushes-popup"></a><h3>gimp_brushes_popup ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_brushes_popup (<em class="parameter"><code>const <span class="type">gchar</span> *brush_callback</code></em>,
                    <em class="parameter"><code>const <span class="type">gchar</span> *popup_title</code></em>,
                    <em class="parameter"><code>const <span class="type">gchar</span> *initial_brush</code></em>,
                    <em class="parameter"><code><span class="type">gdouble</span> opacity</code></em>,
                    <em class="parameter"><code><span class="type">gint</span> spacing</code></em>,
                    <em class="parameter"><code><a class="link" href="libgimp3-gimpenums.html#GimpLayerMode" title="enum GimpLayerMode"><span class="type">GimpLayerMode</span></a> paint_mode</code></em>);</pre>
<p>Invokes the Gimp brush selection.</p>
<p>This procedure opens the brush selection dialog.</p>
<div class="refsect3">
<a name="gimp-brushes-popup.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>brush_callback</p></td>
<td class="parameter_description"><p>The callback PDB proc to call when brush selection is made.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>popup_title</p></td>
<td class="parameter_description"><p>Title of the brush selection dialog.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>initial_brush</p></td>
<td class="parameter_description"><p>The name of the brush to set as the first selected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>opacity</p></td>
<td class="parameter_description"><p>The initial opacity of the brush.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>spacing</p></td>
<td class="parameter_description"><p>The initial spacing of the brush (if &lt; 0 then use brush default spacing).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>paint_mode</p></td>
<td class="parameter_description"><p>The initial paint mode.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brushes-popup.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brushes-close-popup"></a><h3>gimp_brushes_close_popup ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_brushes_close_popup (<em class="parameter"><code>const <span class="type">gchar</span> *brush_callback</code></em>);</pre>
<p>Close the brush selection dialog.</p>
<p>This procedure closes an opened brush selection dialog.</p>
<div class="refsect3">
<a name="gimp-brushes-close-popup.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>brush_callback</p></td>
<td class="parameter_description"><p>The name of the callback registered for this pop-up.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brushes-close-popup.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brushes-set-popup"></a><h3>gimp_brushes_set_popup ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_brushes_set_popup (<em class="parameter"><code>const <span class="type">gchar</span> *brush_callback</code></em>,
                        <em class="parameter"><code>const <span class="type">gchar</span> *brush_name</code></em>,
                        <em class="parameter"><code><span class="type">gdouble</span> opacity</code></em>,
                        <em class="parameter"><code><span class="type">gint</span> spacing</code></em>,
                        <em class="parameter"><code><a class="link" href="libgimp3-gimpenums.html#GimpLayerMode" title="enum GimpLayerMode"><span class="type">GimpLayerMode</span></a> paint_mode</code></em>);</pre>
<p>Sets the current brush in a brush selection dialog.</p>
<p>Sets the current brush in a brush selection dialog.</p>
<div class="refsect3">
<a name="gimp-brushes-set-popup.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>brush_callback</p></td>
<td class="parameter_description"><p>The name of the callback registered for this pop-up.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>brush_name</p></td>
<td class="parameter_description"><p>The name of the brush to set as selected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>opacity</p></td>
<td class="parameter_description"><p>The initial opacity of the brush.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>spacing</p></td>
<td class="parameter_description"><p>The initial spacing of the brush (if &lt; 0 then use brush default spacing).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>paint_mode</p></td>
<td class="parameter_description"><p>The initial paint mode.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brushes-set-popup.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>